/*
 * Copyright (c) 2022-2023 Termony Co., Ltd. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 *    conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 *    of conditions and the following disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
 *    to endorse or promote products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _LOS_ARCH_GIC_H
#define _LOS_ARCH_GIC_H

#include "los_config.h"
#include "los_compiler.h"

#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */

#ifndef LOSCFG_PLATFORM_GIC_NUMBER
#define LOSCFG_PLATFORM_GIC_NUMBER 1
#endif

#ifndef LOSCFG_PLATFORM_CPU_NUMBER
#define LOSCFG_PLATFORM_CPU_NUMBER 1
#endif

UINT32 HalGicGetActiveIrq(UINT32 gic);
VOID HalGicIrqAck(UINT32 gic, UINT32 irqId);

VOID HalGicIrqMask(UINT32 gic, UINT32 irqId);
VOID HalGicIrqUmask(UINT32 gic, UINT32 irqId);

VOID HalGicBroadcastSgi(UINT32 gic, UINT32 irqId);
VOID HalGicSinglecastSgi(UINT32 gic, UINT32 irqId, UINT32 cpuId);
VOID HalGicMulticastSgi(UINT32 gic, UINT32 irqId, UINT32 targetList);

UINT32 HalGicGetPendingIrq(UINT32 gic, UINT32 irqId);
VOID HalGicSetPendingIrq(UINT32 gic, UINT32 irqId);
VOID HalGicClearPendingIrq(UINT32 gic, UINT32 irqId);

VOID HalGicSetIrqConfig(UINT32 gic, UINT32 irqId, UINT32 config);
UINT32 HalGicIrqGetConfig(UINT32 gic, UINT32 irqId);

VOID HalGicIrqSetTargetCpu(UINT32 gic, UINT32 irqId, UINT32 cpuMask);
UINT32 HalGicIrqGetTargetCpu(UINT32 gic, UINT32 irqId);

VOID HalGicSetIrqPriority(UINT32 gic, UINT32 irqId, UINT8 priority);
UINT8 HalGicGetIrqPriority(UINT32 gic, UINT32 irqId);

VOID HalGicSetInterfacePriorityMask(UINT32 gic, UINT8 priority);
UINT8 HalGicGetInterfacePriorityMask(UINT32 gic);

VOID HalGicSetBinaryPoint(UINT32 gic, UINT32 binaryPoint);
UINT32 HalGicGetBinaryPoint(UINT32 gic);

VOID HalGicSetGroup(UINT32 gic, UINT32 irqId, UINT32 group);
UINT32 HalGicGetGroup(UINT32 gic, UINT32 irqId);

UINT32 HalGicGetIrqStatus(UINT32 gic, UINT32 irqId);
VOID HalGicClearActiveIrq(UINT32 gic, UINT32 irqId);

UINT32 HalGicGetHighPendingIrq(UINT32 gic);

UINT32 HalGicGetInterfaceId(UINT32 gic);

UINT32 HalGicGetMaxIrqNum(VOID);

VOID HalGicInit(UINT32 gic, UINT32 startIrqId);

VOID HalGicDumpType(UINT32 gic);
VOID HalGicDump(UINT32 gic);

#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */

#endif /* _LOS_ARCH_GIC_H */

